KFbxProgress Class Reference

#include <kfbxprogress.h>

List of all members.

---

Detailed Description

Class for progress reporting.

Definition at line 57 of file kfbxprogress.h.

Public Member Functions
	KFbxProgress ()
	~KFbxProgress ()
void	SetTotal (float pTotal)
	Set the total amount of workload.
void	Add (float pDetaWorkload, const KString &pStatus)
	Report recent finished workload.
void	Reset ()
	Reset the progress status.
void	Compete (const KString &pStatus)
	Set the progress status to completed.
float	GetProgress (KString &pStatus) const
	Retrieve the progress status.
void	SetProgressCallback (KFbxProgressCallback pCallback)
	Register a callback function for progress reporting in single thread mode.

---

Constructor & Destructor Documentation

KFbxProgress

(

)

~KFbxProgress

(

)

---

Member Function Documentation

void SetTotal

(

float

pTotal

)

Set the total amount of workload.

Parameters:

pTotal

Total amount of workload

void Add	(	float	pDetaWorkload,
		const KString &	pStatus
	)

Report recent finished workload.

Parameters:

	pDetaWorkload	Amount of workload
	pStatus	Current progress status

void Reset

(

)

Reset the progress status.

void Compete

(

const KString &

pStatus

)

Set the progress status to completed.

Parameters:

pStatus

Current progress status

float GetProgress

(

KString &

pStatus

)

const

Retrieve the progress status.

Parameters:

pStatus

Current progress status

Returns:

Percentage

void SetProgressCallback

(

KFbxProgressCallback

pCallback

)

Register a callback function for progress reporting in single thread mode.

Parameters:

pCallback

Pointer of the callback function